Mention source of `elements` database in docstring #87

ericpre · 2024-09-18T13:43:31Z

As mentioned in #85 (comment).

Progress of the PR

Mention source of elements database in docstring,
docstring updated (if appropriate),
update user guide (if appropriate),
[n/a] added tests,
add a changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
Check formatting of the changelog entry (and eventual user guide changes) in the docs/readthedocs.org:exspy build of this PR (link in github checks)
ready for review.

doc/reference/material.rst

codecov · 2024-09-18T13:49:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.70%. Comparing base (ee31d0a) to head (0f9d7c0).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   88.70%   88.70%           
=======================================
  Files          77       77           
  Lines        7453     7453           
  Branches     1200     1200           
=======================================
  Hits         6611     6611           
  Misses        572      572           
  Partials      270      270

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

exspy/_misc/elements.py

jlaehne · 2024-09-18T13:54:12Z

Chantler reference is already mentioned in other docstrings, but way of mentioning is quite inconsistent.

ericpre · 2024-09-18T14:32:34Z

Chantler reference is already mentioned in other docstrings, but way of mentioning is quite inconsistent.

@jlaehne, is it better now with the references?

exspy/_misc/elements.py

doc/reference/material.rst

exspy/_misc/elements.py

jlaehne · 2024-09-18T14:56:37Z

Chantler reference is already mentioned in other docstrings, but way of mentioning is quite inconsistent.

@jlaehne, is it better now with the references?

Maybe align also the citation in the Bibliography of the User Guide (use DOI, it currently uses the subtitle and not the title of the page).

Co-authored-by: Jonas Lähnemann <[email protected]>

…rings

ericpre added the needs review label Sep 18, 2024

ericpre added this to the v0.3 milestone Sep 18, 2024

ericpre added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 18, 2024